Add leader_add_user callback #24266
Open
Add leader_add_user callback #24266
+31
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drashna
reviewed
Aug 30, 2024
quantum/leader.c
Outdated
| @@ -61,6 +63,9 @@ bool leader_sequence_add(uint16_t keycode) { | |||
| leader_sequence[leader_sequence_size] = keycode; | |||
| leader_sequence_size++; | |||
|
|
|||
| if (leader_add_user()) { | |||
There was a problem hiding this comment.
It might make sens to pass the keycode to the user function here.
There was a problem hiding this comment.
Thank you for the response. I have added the keycode as a parameter to the leader_add_user callback and updated the documentation accordingly.
|
Thank you for your contribution! |
github-actions
bot
added
the
stale
|
Needs review. |
github-actions
bot
removed
the
stale
drashna
approved these changes
Oct 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added a user callback
bool leader_add_user()for when keys are added to the leader key sequence. This callback can then be used in the user configuration to check keys as soon as they are added to the leader sequence. Whentrueis returned, it will cause the leader sequence to end immediately, and false will continue the sequence as usual.This opens a couple of new possibilities for user configuration, including auto-terminating leader sequences - where when a valid sequence is checked the leader sequence will end immediately, removing the delay at the end of the sequence. Additionally, for keyboards with OLED screens, it can allow for a which-key style menu to appear during the leader sequence. Both of these features are implemented in my personal userspace.
Types of Changes
Issues Fixed or Closed by This PR
None, additional functionallity.
Checklist